DeleteCheckPointUserRecord

SoftwareShield CheckPoint™ License Server > CheckPoint™ License Server Interfaces > CheckPoint_Webservice_References > DeleteCheckPointUserRecord

## DeleteCheckPointUserRecord

The DeleteCheckPointUserRecord function will delete a CheckPoint User from the database.

###### Syntax

TRecordResponse * DeleteCheckPointUserRecord( TCheckPointUserRecord * ACheckPointUserRecord, BSTR ASessionID ) ;

###### Parameters

ACheckPointUserRecord

[IN] This is a TCheckPointUserRecord class which defines which user should be deleted. The fields of interest are:

- CheckPointUserID- this field should contain the User ID of the user to be deleted.

ASessionID

[IN] This is the session ID of the logged in user.

###### Remarks

This function does not remove the CheckPoint User entry from the database. Each CheckPoint Users has a deleted field associated to them. This function will set the deleted field to true. This will allow the recovery of accidental deletion by manually entering the database and set the flag back to false.

Only administrators are allowed to use this function.

###### Return Value

Returns the custom class TRecordResponse. The fields of interest that is related to this method are:

- Success- True will be returned if this function was successful, otherwise false will be returned.

- ErrorMessage- if an error occurred, the associated error message can be found in this field.

###### Function Information

Exposed By Interface: | "ICheckPointService"
Exposed In ISAPI DLL: | "checkpoint.dll"